fix(PRU-ICSS): Convert literal blocks to code-blocks#344
Merged
Conversation
danish-ti
requested review from
StaticRocket,
VeeruPrudhvi,
aniket-l,
cshilwant,
praneethbajjuri and
uditkumarti
as code owners
|
New warnings found with rstcheck: |
danish-ti
force-pushed
the
pru-sphinx-fix
branch
3 times, most recently
from
8b34163 to
ce969c8
Compare
StaticRocket
requested changes
Jul 7, 2025
This patch updates the PRU_ICSSG_Ethernet.rst and PRU_ICSSG_Ethernet_Switch.rst documentation files to improve Sphinx compatibility and readability. The following changes are made: - Replaces all occurrences of "::" used for literal/code blocks with ".. code-block:: console" and ensures proper indentation for code examples and command-line snippets. - Updates all code and command output blocks to use the correct Sphinx directive, which enables syntax highlighting and consistent formatting in generated documentation. - Fixes minor typos in comments and documentation text, such as correcting "Fore more details" to "For more details" and improving clarity. - Ensures consistent formatting of code blocks, command outputs, and configuration examples throughout the documentation. - No functional or content changes are made to the technical information; all updates are limited to documentation formatting and style. Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
StaticRocket
approved these changes
Jul 8, 2025
praneethbajjuri
approved these changes
Jul 9, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This patch updates the PRU_ICSSG_Ethernet.rst and
PRU_ICSSG_Ethernet_Switch.rst documentation files to improve Sphinx compatibility and readability. The following changes are made: